home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 September / Macworld (1998-09).dmg / Shareware World / Comms & Internet / Cinnamon WebMaster Suite 1.3 / Read Me Please! < prev    next >
Text File  |  1998-06-17  |  23KB  |  319 lines

  1.             Cinnamon WebMaster Suite
  2.                                                                                                         Version 1.3
  3.  
  4. ***** Please read this document thoroughly, but for a quick over- *****
  5. ***** view of changes and new features in this version, please see *****
  6. ***** the "Version History" section at the bottom.                              *****
  7.  
  8. Contents
  9.  
  10.     Introduction
  11.     What is Cinnamon WebMaster Suite?
  12.     How to use CWMS
  13.     Special Features
  14.     How much does Cinnamon WebMaster Suite cost?
  15.     About Cinnamon Computer Products
  16.     Licensing and Distribution Information
  17.     Future Additions
  18.     Compatibility
  19.     Known Problems & Issues
  20.     Version History
  21.     BugZappers Hall of Fame
  22.     Legal Information
  23.  
  24. Introduction
  25.  
  26. Thank you for downloading Cinnamon WebMaster Suite! This is the first product of Cinnamon Soft, a division of Cinnamon Computer Products. Cinnamon WebMaster Suite (CWMS) will eventually turn into a full-fledged commercial product, but for now it was originally intended for my own use. I have decided to release it as shareware in the meantime, because it is already a fully-functional and very useful product.
  27.  
  28. What is Cinnamon WebMaster Suite?
  29.  
  30. CWMS is a straightforward, yet very useful and useable, HTML editor. It is the perfect solution for Mac OS-based Web Page Design. It is compact, yet full of features.
  31.  
  32. Cinnamon WebMaster Suite was created to fulfill a need. WYSIWYG web page programs such as Adobe Pagemill just simply don't do the job. If I was going to have to write my own HTML, I needed a good editor--one that did more than a regular word processor, one that specifically helped me write web pages. It was out of this need that I created CWMS. It has all the capabilities of a simple text editor, with many special features dealing with HTML. As you read about and use Cinnamon WebMaster Suite, you will begin to discover these wonderful features. They hide well, but always ready to spring into action!
  33.  
  34. How to use CWMS
  35.  
  36. Using Cinnamon WebMaster Suite is quite easy. Everything is standard Mac OS. To open the program, you can double-click its icon or the icon of a document created by CWMS.
  37.  
  38. The Apple Menu
  39. • About Cinnamon WebMaster Suite
  40.     Displays information about CWMS
  41. • About Cinnamon Soft
  42.     Displays information about CCP
  43.  
  44. The File Menu
  45. • New
  46.     Creates a blank new document
  47. • Open…
  48.     Open an existing document (Usually an HTML document, but you can open any TEXT file)
  49. • Close
  50.     Close the current document
  51. • Save
  52.     Save the current document (If untitled, will automatically function as Save As…)
  53. • Save As…
  54.     Saves the current document as a new document and switches to the new one
  55. • Export…
  56.     Saves the current document as a new document without switching to the new one
  57. • Revert to saved
  58.     Reverts a document to its last saved form
  59. • Quit
  60.     Quits the program after closing all open documents
  61.  
  62. The Edit Menu
  63. • Undo
  64.     Undo does not function in this version of CWMS (see Future Additions, below)
  65. • Cut, Copy, Paste, Clear
  66.     The standard Mac OS clipboard commands
  67. • Select All
  68.     Selects the entire document
  69. • Show/Hide Find Controls *** New in v1.3 ***
  70.     Shows or Hides the Find Controls for the active window
  71. • Find Next *** New in v1.3 ***
  72.     Finds the next occurence of the search string - same as clicking 'Find' button
  73. • Replace & Find Next *** New in v1.3 ***
  74.     Replaces the found text and finds next occurence - same as clicking 'Replace' button
  75. • Enter 'Find' String *** New in v1.3 ***
  76.     Enters the selected text as the new search string
  77. • Insert Color…
  78.     Using the Apple Color Picker, automatically formats and inserts the HTML color code
  79. • Insert Current Date
  80.     Betcha can't guess...
  81. • Insert Current Time
  82.     Another no-brainer...
  83. • Colorize Tags in Selection
  84.     Color-codes the tags & comments in the selected area of text
  85. • Preferences *** New in v1.3 ***
  86.     Shows the Preferences dialog
  87.  
  88. The Text Menu *** New in v1.3 ***
  89. • Monaco, Geneva, New York *** New in v1.3 ***
  90.     Sets the font for the active document
  91. • 9, 10, 12, 14 point *** New in v1.3 ***
  92.     Sets the font size for the active document
  93.  
  94. The Window Menu
  95.     Any open documents are displayed under this menu, in alphabetical order
  96.  
  97. Special Features
  98.  
  99. What makes Cinnamon WebMaster Suite useful are the HTML-specific features. Here is an explanation of all current features:
  100.  
  101. • Color-coding
  102.     All text is color-coded for ease of reading. HTML tags are blue, comments are green,
  103.     quoted text inside tags is red, and all other text is black.
  104. • Automatic Capitalization of tags
  105.     It is customary to type HTML tags in all-caps, but it is very annoying to have to keep
  106.     switching Caps Lock on and off all the time. Go ahead and type tags in lowercase, and
  107.     CWMS will automatically convert each tag to uppercase when you type the ">" at the
  108.     end of the tag. Also, it is smart enough not to convert text which is in quotes.
  109.     Some common JavaScript keywords are now exempted from auto-caps. (See Version
  110.     History, below) If there are any others you use frequently, let me know.
  111. • ISO-Latin Key Filtering
  112.     CWMS will only allow you to type characters which can be represented in the standard 
  113.     character set of the Internet. (see next item for related info)
  114. • Automatic Special Character Conversion
  115.     In Internet character sets, special characters are represented with embedded
  116.     shortcut values or phrases. For example, "á" should be entered into a web page using
  117.     "á" or else the incorrect character will be displayed on other computer types.
  118.     CWMS automatically converts special characters to their special codes. Type special
  119.     characters just as you normally would on a Macintosh. If nothing appears, you cannot
  120.     use that particular character on the Internet, although almost all characters can be.
  121.     Option-Space is a shortcut for the " " character phrase, which is used primarily
  122.     as a filler in blank lines or blank table cells to make them appear.
  123. • Smart Deletion of Special Character Phrases
  124.     The Smart Delete feature will recognize a special character code such as "©"
  125.     (the copyright symbol) and will delete the entire code phrase. This will only occur if
  126.     the cursor is immediately after the semicolon when you hit delete. If the cursor is
  127.     anywhere else, the delete key will function normally.
  128. • Smart Entry of Multi-Purpose Characters
  129.     There are several characters which, in addition to being part of regular text, are also
  130.     used within HTML commands. These characters include "<", ">", "&", and """. A simple
  131.     and powerful shortcut has been devised: The first time you type one of these
  132.     characters, it is assumed that you meant to use them for HTML code, and they appear
  133.     like normal. If you instead wanted the character-code to be inserted, all you have to
  134.     do is type the character again! Any time you type one of these characters a second
  135.     time in a row, the first one is automatically removed and replaced with the code!
  136. • Smart Comments maintain compatibility
  137.     The old way of creating a comment was to make a single tag starting with "<!". The
  138.     new method is to use the <COMMENT> and </COMMENT> tags. CWMS supports both
  139.     methods, but you should always use the new method because the old method will not
  140.     be supported in future web browsers, causing your comments to be displayed as part
  141.     of the page. The recommended method is to use both--place the <!--> tag between the
  142.     <COMMENT> and </COMMENT> tags. This way, all browsers will see one or the other.
  143.     If you begin typing an old-style comment, CWMS will assist you by automatically
  144.     converting it to a mixed-style comment. CWMS will not modify new-style comments.
  145.     As of v1.2, "</!" is now a shortcut for "</COMMENT". Note: It is a common practice
  146.     when using JavaScript to 'hide' the code from non-compatible browsers using the old
  147.     "<!" tag without the "<COMMENT>" tag. CWMS will now recognize that you are typing an
  148.     old-style comment immediately after a <SCRIPT> tag and will not insert a
  149.     <COMMENT>. The ! character is now an all-around shortcut for the word COMMENT.
  150.     CWMS will still automatically convert to mixed-style comments if you type it again.
  151. • "Insert Color" option
  152.     This shortcut command makes it easy to insert or modify HTML color hex codes. As of
  153.     v1.1.1, in order to further enhance the useability of Insert Color, it has been
  154.     significantly improved. The "#" symbol is now smart, i.e. it will automatically be
  155.     inserted at the beginning of the hex code only if there isn't already one there. Also,
  156.     by double-clicking the hex value of a preexisting color before choosing Insert Color,
  157.     the "old" color in the color picker will be the preexisting color. If no preexisting color
  158.     is selected, the last color that was inserted (into any document) is the default color.
  159. • "Colorize Tags in Selection" option
  160.     This option color-codes all the tags & comments in the selected area of text. Useful
  161.     for updating the colorization of tags which may have been uncolorized during editing.
  162.     The process can be stopped at any time with command-period.
  163. • NEW in v1.3 - Find & Replace system
  164.     The Find & Replace system I've implemented in CWMS isn't done the standard way, and
  165.     I think you'll like it a lot. The Find Controls are built right into the document window.
  166.     They can be shown or hidden at any time, and you can choose the default status.
  167.  
  168. How much does Cinnamon WebMaster Suite cost?
  169.  
  170. Everyone: Cinnamon WebMaster Suite is $5.00 shareware. (Iowa residents $5.25). Send in those Registrations! This program is being distributed on a shareware basis because it isn't ready to be sold commercially, but it's plenty good enough to be quite useful. By registering as a user of Cinnamon WebMaster Suite, you will gain several advantages:
  171.  
  172. • Email notification of new versions or products
  173. • A clear conscience knowing that you're honest
  174. • Free updates between major versions
  175. • I will be encouraged to continue to expand CWMS
  176.  
  177. ***** To register, please print and fill out the registration form found in the same folder as this document, and send it to:
  178.  
  179. Cinnamon Computer Products
  180. Cinnamon Soft Division
  181. 410 W. Meadow Lane
  182. Marshalltown, IA 50158-5113
  183.  
  184. If sending Cash, be sure to use a security envelope, and also wrap the cash inside the registration form. If you live in Iowa, you must add 5% sales tax ($5.25 is the total). If sending check or money order, please make payable to Cinnamon Computer Products.
  185.  
  186. The most recent version of CWMS, can be downloaded from the Cinnamon Soft web site at: http://members.aol.com/dustynk/cinnamonsoft/
  187.  
  188. Registered users of CWMS only: Version 1.3 is a complimentary upgrade for anyone who has paid for any previous version.
  189.  
  190. About Cinnamon Computer Products
  191.  
  192. Cinnamon Computer Products is the trade name of Dusty Kothenbeutel, an interactive game and computer professional, and above all a futurist, living in Marshalltown, IA. Cinnamon Computer Products has two divisions:
  193.  
  194. Cinnamon Soft creates useful software for Mac OS-based computers. Cinnamon WebMaster Suite is the trademark product of Cinnamon Soft. Later on, Cinnamon Soft will become a major software developer for multiple platforms. Cinnamon GameSoft is a division of Cinnamon Soft, dedicated to producing cool new games for various platforms. Currently, our first simple game is out as freeware, known as SuperBike.
  195.  
  196. CinnaByte Internet Services provides high-quality Web Site Design, Web Site Hosting, and Dial-Up Internet Access. For more information, send email to dustynk@aol.com, or visit http://members.aol.com/dustynk/cinnabyte/, or write to the address above.
  197.  
  198. Licensing and Distribution Information
  199.  
  200. This version of Cinnamon WebMaster Suite is shareware, and may be freely distributed across the Internet, online services, and BBSs, as long as the entire software package (the Cinnamon WebMaster Suite application and all accompanying documents, most importantly "Read Me Please!" and "Registration Form", as well as the folder which contains them) is always included and not modified in any way.
  201.  
  202. You are permitted to use this software on a trial basis for a period of up to 30 days, at which time you must send in the completed registration form and $5.00 registration fee (Iowa residents $5.25), or remove the program from your computer. Please send copies of the software package on to everyone you know.
  203.  
  204. Except for the following, the software package may not be included on or in any package or media which is to be sold, or distributed by means other than by modem, without prior written permission (an email response from dustynk@aol.com sufficiently qualifies as written permission) of Cinnamon Soft.
  205.  
  206. 1) If you have obtained permission for any previous version of this software package, this permission is hereby extended to this version as well. (I would still appreciate being notified). However, this rule does not apply if you or the party you represent made payment to Cinnamon Computer Products or Dusty Kothenbeutel in order to secure the prior permission.
  207.  
  208. 2) Permission to include this software package is hereby granted to you ahead of time, without a need to contact Cinnamon Computer Products or Dusty Kothenbeutel prior to the release of your package or product, if a complete copy of the entire package or product is sent to Cinnamon Computer Products at the above address, either free of charge, or with a standard shipping charge of no more than $5.00 US.
  209.  
  210. 3) Magazines which include a CD-ROM with each issue (such as MacAddict) need not ask permission to include CWMS, because in my opinion they aren't selling the CD, they're packaging it as part of the mag.
  211.  
  212. Contact Cinnamon Soft at the address above for details or to work out an agreement.
  213.  
  214. Future Additions
  215.  
  216. These are just a sampling of features and capabilities which are being planned for addition to future versions of Cinnamon WebMaster Suite:
  217.  
  218. • Totally rewritten in C for speed and capability gains
  219. • Option to capitalize all preexisting tags in a document
  220. • Ability to create plain text documents as well as HTML documents
  221. • Menu/Command-key shortcuts for commonly used tags
  222. • FKey shortcuts for commonly used tags
  223. • Print routine
  224. • Ability to Undo
  225. • Shortcut for automatically entering end tags (such as </BODY> or </COMMENT>)
  226. • User-definable shortcuts
  227. • and many more!
  228.  
  229. Compatibility
  230.  
  231. Cinnamon WebMaster Suite has been tested and is thought to be fully-functional under Mac OS System 7 through 8.1. The program is extremely non-volatile, but, regardless of what computer model or system version you have, no guarantees are made that this software will function appropriately or at all. You use this software at your own risk. No responsibility or liability on the part of Cinnamon Computer Products shall exist.
  232.  
  233. If you do have any problems of any sort, please report them to me at dustynk@aol.com, or at the address above. I am very grateful for the reporting of any weaknesses or flaws in this software. Please include a detailed summary including a description of what happened, what you were trying to do, your computer model and configuration, any errors or messages you received, what system software you were using, etc. I may be able to suggest an immediate solution, or work one into the next version.
  234.  
  235. Known Problems & Issues
  236.  
  237. ***** A current listing of known bugs & issues, if any, will be posted on the     *****
  238. ***** Cinnamon Soft site at http://members.aol.com/dustynk/cinnamonsoft/    *****
  239.  
  240. • Only two people have ever reported an inability to get CWMS to work, and both of them have Power Mac 7100s. If you have any problems, especially with a 7100, please let me know. I haven't been able to find any reason yet.
  241. • Several of you have reported a miscolorization bug while typing text immediately after a tag. However, this is not a bug in CWMS. It is an unfortunate side effect which is generated intentionally by the Mac OS. Specifically, the built-in Mac OS text services, known as TextEdit, always apply the same formatting to a typed character as the character immediately before it. This is desirable in nearly all programs, namely word processors. In CWMS, it happens to be a bit undesirable at times. I have worked around it when you are typing text right in a row. But if you use the mouse to place the cursor in a different position, the miscolorization will occur. Unfortunately, there is currently nothing I can do about it because the System does it from beyond CWMS's knowledge or control. I will have resolved the issue by the time version 2.0 is released, because I am writing a custom application environment for the next incarnation of CWMS. In the meantime, this is the reason why I made the "Colorize tags" into a menu option, so that you can clean up the colors any time you want to.
  242. • Choosing Cut, Paste, or Clear from the menu does not register as a change to an unchanged document. FutureBASIC handles the Edit Menu itself and won't allow CWMS to "see" them. (I bet you wouldn't have even noticed this one!) This will be corrected when CWMS is rewritten in C. Workaround #1: Using the command-key shortcuts for Cut or Paste will register as a change. Workaround #2: Make a simple change and undo it.
  243. • Undo is greyed out, because it hasn't been programmed yet
  244.  
  245. Version History
  246.  
  247. • 1.0 - January 30, 1998
  248.     * This is the initial release.
  249. • 1.1 - February 8, 1998
  250.     * Added "Insert Color" feature under Edit Menu
  251.     * Added "</!" as a shortcut for "</COMMENT" as an addition to Smart Comments
  252.     * Corrected a problem where "Save" and "Revert" were not activated/deactivated when switching between documents
  253.     * Corrected a minor colorization problem with one variety of Smart Comments
  254. • 1.1.1 - February 16,1998
  255.     * Windows will now behave properly when resized
  256.     * "Insert Color" now registers as a change to the document
  257.     * "Insert Color" is totally revamped to increase functionality and ease of use:
  258.             * The "#" sign only gets inserted if it's not already there
  259.             * Selecting a preexisting hex color code before choosing Insert Color will use the preexisting color as the default in the color picker
  260.             * If no preexisting hex code is selected, the last color to be inserted is the default
  261.     * The information in the "About Cinnamon Computer Products" window was updated to reflect the address of Cinnamon Soft's new website
  262.     * Added new icons. Big thanks to Eric Ward (ericward@xmission.com), they're great! Note: If the icons don't change, you'll need to rebuild your desktop.
  263. • 1.1.2 - February 26, 1998
  264.     * Added "Colorize Tags in Selection" option under Edit menu. Color-codes all the tags & comments in the selected text, just like it says.  8-)   This is done automatically when a document is first opened, but after editing, there can be tags left uncolored.
  265.     * The Colorization process can now be cancelled at any time during the process. The current incarnation of the Colorize routine is very slow on large files--for example, on my computer it takes over 25 minutes to open this Read Me file. In actuality, it takes less than half a second to load the file, and 25 minutes to colorize it, so I added the command-period abort routine to save time and eliminate hassle. You can always use the new Colorize option on selected parts of the file later.
  266.     * You can now make selections using shift-arrow keys. It has some bugs, but it'll do until I can learn how to implement the Macintosh Drag Manager properly.
  267.     * Removed the ellipsis from the "New" option under the File menu. Once I implement some other file types, it will return and be proper. (Thanks to Scott Knick for noticing that one)
  268. • 1.1.3 - March 2, 1998
  269.     * Corrected a bug where a '!' anywhere in a tag would cause it to be comment-colored instead of tag-colored (reported by Scott Knick)
  270.     * Corrected a bug where typing a '!' did not register as a change to the document
  271.     * Includes several new files: An AutoTyper to convert TEXT files to have a CWMS creator type, and a small icon to be included on web pages created with CWMS with a link back to the Cinnamon Soft website.
  272. • 1.2 - March 17, 1998
  273.     * The following JavaScript keywords are now exempted from Auto-capitalization for aesthetic reasons: onClick, onFocus, onBlur, onChange, onMouseOver, onMouseOut, onSelect, onSubmit, onReset
  274.     * Added an Insert Date option under the Edit menu
  275.     * Added an Insert Time option under the Edit menu
  276.     * Added a new "Made with CWMS" graphic, courtesy of Oliver Mandic
  277. • 1.2.1 - April 7, 1998
  278.     * Smart Comments have gained another IQ point. It is common for JavaScript users to use an old-style comment (<!-- -->) around the code to hide it from non-Java-capable browsers. Smart Comments will now differentiate between a regular comment and one following a <SCRIPT> tag, and will not convert the old-style tag into a new-style one. (Thanks to Scott Knick for reporting the problem)
  279.     * Fixed a small bug with the Colorize tags option, which failed to colorize plain text
  280. • 1.2.2 - April 27, 1998
  281.     * Added a new Smart Delete feature -- CWMS will now recognize a special character code phrase such as " " and will delete the entire phrase if the cursor is just behind the semicolon when you hit delete. (Thanks to Romain for the suggestion)
  282.     * Added a new shortcut -- Option-Space will now insert the " " code phrase, which is used for filling a blank space into <P> tags and table cells.
  283. • 1.2.3 - May 11, 1998
  284.     * The missing character code for the Ö character has been added. (First reported by Frogoff Ataka)
  285.     * The routine that handles the ! key has been revamped. Now ! is the shortcut for the word COMMENT. CWMS will still automatically convert to mixed-style comments, just type the ! key a second time.
  286. • 1.2.4 - May 26, 1998
  287.     * I discovered and corrected a bug which prevented an '!' from being typed after any 't'.
  288.     * I finally figured out a way to colorize quoted text inside tags. It will appear red.
  289. • 1.3 - June 17, 1998
  290.     * Added choice of Font and Size for each document
  291.     * Added Zoom Boxes to documents
  292.     * Added full-featured Find & Replace system
  293.     * Added number-key shortcuts to Window Menu
  294.     * Documents remember Font and Size
  295.     * Documents remember Window Size and Position
  296.     * Documents remember text selection
  297.     * Improved default window size for monitors larger than 640x480
  298.     * Added Preferences feature. The program remembers:
  299.             * Default Font & Size
  300.             * Whether to Colorize documents by default
  301.             * Whether to show Find Controls by default
  302.     * Corrected a bug which caused a system crash if opening or saving a zero-length file (reported by R. Lambert)
  303.     * CWMS now actually requires System 7 or higher. This is to prevent bugs, and I seriously doubt anyone out there has System 6 anyway!
  304.     * Menu commands relating to the currently-selected text now activate/deactivate in response to the selected text
  305.  
  306. BugZappers Hall of Fame
  307.  
  308. Here's your chance to live forever! Send in a bug report, and get your name in the Hall of Fame! Only new and unknown bugs count.
  309.  
  310.     1) Scott Knick - 3 bugs
  311.     2) Frogoff Ataka - 1 bug
  312.             R. Lambert
  313.  
  314. Legal Information
  315.  
  316. All products, names, and companies mentioned in this document are the trademarks, registered trademarks, or other property of their respective companies.
  317.  
  318. ©1998 Cinnamon Computer Products. All Rights Reserved.
  319.